Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for output action attributes #13236

Merged
merged 2 commits into from
Jan 31, 2022

Conversation

bernt-matthias
Copy link
Contributor

@bernt-matthias bernt-matthias commented Jan 24, 2022

For #12724 I tried to understand output actions. Have to admit that even after studying the code I have no idea (that goes beyond the examples in the docs) what they are doing .. also they seem overly complex. Maybe this bit of added documentation is a small step forward ... But I also added a statement that tool provided metadata should be used instead (which is undocumented to a similar extent).

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these contributions under Galaxy's current license.
  • I agree to allow the Galaxy committers to license these and all my past contributions to the core galaxy codebase under the MIT license. If this condition is an issue, uncheck and just let us know why with an e-mail to [email protected].

- document that tool provided metadata should be preferred over the
``actions`` tag. galaxyproject/planemo#1167
should be merged first
- add documentation for tags
- + 2 TODOs in tool_util/parser/output_actions.py
@github-actions github-actions bot added this to the 22.05 milestone Jan 24, 2022
@@ -4857,6 +4857,8 @@ Galaxy, including:
<xs:complexType name="Actions">
<xs:annotation>
<xs:documentation xml:lang="en"><![CDATA[
The functionality of the ``actions`` tag should be replaced by
[tool provided metadata](https://planemo.readthedocs.io/en/latest/writing_advanced.html#tool-provided-metadata).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just don't know that I think this is true. The XML may be undocumented but at least it is structured and declarative. In terms of how the workflow editor works, job collection, etc.. it seems we can be a lot smarter about output actions. It feels like tool provided metadata should be the fallback (despite me knowing a lot more about it and such).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these the actions this refers to ?

Yes

I just don't know that I think this is true.

That is such a wonderful sentence ;).

So let's just remove my sentence about the tool provided metadata.

@mvdbeek mvdbeek modified the milestones: 22.05, 22.01 Jan 31, 2022
@mvdbeek mvdbeek merged commit e88e5da into galaxyproject:dev Jan 31, 2022
@github-actions
Copy link

This PR was merged without a "kind/" label, please correct.

@mvdbeek mvdbeek changed the title add documentation for output action attributes Add documentation for output action attributes Feb 15, 2022
@bernt-matthias bernt-matthias deleted the doc/output-actions branch March 14, 2022 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants